fix flaky search index application by shrabantipaul-collate · Pull Request #26795 · open-metadata/OpenMetadata

shrabantipaul-collate · 2026-03-26T10:33:31Z

Describe your changes:

Fixes

I worked on ... because ...

Type of change:

Checklist:

I have read the CONTRIBUTING document.
My PR title is Fixes <issue-number>: <short explanation>
I have commented on my code, particularly in hard-to-understand areas.
For JSON Schema changes: I updated the migration scripts or explained why it is not needed.

Summary by Gitar

Test refactoring:
- Extracted installSearchIndexApplication function to reduce duplication and enable recovery from failed retries
- Added self-healing guard that reinstalls app via API if previous retry left it uninstalled
Test robustness:
- Added API-based app check and reinstallation to prevent flaky test failures from retry state

_{This will update automatically on new commits.}

github-actions · 2026-03-26T10:33:55Z

Hi there 👋 Thanks for your contribution!

The OpenMetadata team will review the PR shortly! Once it has been labeled as safe to test, the CI workflows
will start executing and we'll be able to make sure everything is working as expected.

Let us know if you need any help!

github-actions · 2026-03-26T11:16:51Z

Jest test Coverage

UI tests summary

Lines	Statements	Branches	Functions
	65% (58732/90354)	44.75% (30898/69045)	47.89% (9318/19455)

github-actions · 2026-03-26T12:37:42Z

🟡 Playwright Results — all passed (20 flaky)

✅ 3419 passed · ❌ 0 failed · 🟡 20 flaky · ⏭️ 216 skipped

Shard	Passed	Flaky	Skipped
🟡 Shard 1	453	2	2
🟡 Shard 2	606	2	32
🟡 Shard 3	610	4	27
🟡 Shard 4	611	6	47
🟡 Shard 5	585	2	67
🟡 Shard 6	554	4	41

🟡 20 flaky test(s) (passed on retry)

Features/CustomizeDetailPage.spec.ts › Glossary Term - customization should work (shard 1, 1 retry)
Pages/UserCreationWithPersona.spec.ts › Create user with persona and verify on profile (shard 1, 1 retry)
Features/BulkEditEntity.spec.ts › Glossary (shard 2, 1 retry)
Features/Glossary/GlossaryStatusFilterNestedTerms.spec.ts › all children have same status different from parent (shard 2, 1 retry)
Features/Permissions/GlossaryPermissions.spec.ts › Team-based permissions work correctly (shard 3, 1 retry)
Features/RestoreEntityInheritedFields.spec.ts › Validate restore with Inherited domain and data products assigned (shard 3, 1 retry)
Features/UserProfileOnlineStatus.spec.ts › Should show "Active recently" for users active within last hour (shard 3, 1 retry)
Flow/ExploreDiscovery.spec.ts › Should display deleted assets when showDeleted is checked and deleted is not present in queryFilter (shard 3, 1 retry)
Pages/Customproperties-part2.spec.ts › entityReferenceList shows item count, scrollable list, no expand toggle (shard 4, 1 retry)
Pages/DomainDataProductsRightPanel.spec.ts › Should display overview tab for data product (shard 4, 1 retry)
Pages/Domains.spec.ts › Data Product announcement create, edit & delete (shard 4, 1 retry)
Pages/Domains.spec.ts › Rename domain with data products attached at domain and subdomain levels (shard 4, 1 retry)
Pages/Domains.spec.ts › Domain Rbac (shard 4, 1 retry)
Pages/Entity.spec.ts › User as Owner with unsorted list (shard 4, 1 retry)
Pages/EntityDataSteward.spec.ts › Follow & Un-follow entity (shard 5, 1 retry)
Pages/ExplorePageRightPanel.spec.ts › Should verify deleted user not visible in owner selection for table (shard 5, 1 retry)
Pages/UserDetails.spec.ts › Create team with domain and verify visibility of inherited domain in user profile after team removal (shard 6, 1 retry)
Pages/Users.spec.ts › Permissions for table details page for Data Consumer (shard 6, 1 retry)
Pages/Users.spec.ts › Check permissions for Data Steward (shard 6, 1 retry)
VersionPages/EntityVersionPages.spec.ts › Directory (shard 6, 1 retry)

📦 Download artifacts

How to debug locally

# Download playwright-test-results-<shard> artifact and unzip
npx playwright show-trace path/to/trace.zip    # view trace

openmetadata-ui/src/main/resources/ui/playwright/e2e/Pages/SearchIndexApplication.spec.ts

…/open-metadata/OpenMetadata into fix-searchIndexApplication-specs

gitar-bot · 2026-03-30T05:00:21Z

openmetadata-ui/src/main/resources/ui/playwright/e2e/Pages/SearchIndexApplication.spec.ts

+        await apiContext.post('/api/v1/apps', {
+          data: {
+            name: 'SearchIndexingApplication',
+            displayName: 'Search Indexing',
+            appConfiguration,
+            appSchedule: { scheduleTimeline: 'None' },
+          },
+        });


💡 Edge Case: Self-healing API POST lacks response-status check

The self-healing guard (lines 171-178) creates the app via apiContext.post('/api/v1/apps', …) but never inspects the response. If the POST fails (e.g., 400 due to a schema change or 500), the test will proceed as if the app is installed, leading to a confusing downstream failure that obscures the real cause.

Adding a status assertion gives a clear, early failure message.

Suggested fix:

const installRes = await apiContext.post('/api/v1/apps', { data: { name: 'SearchIndexingApplication', displayName: 'Search Indexing', appConfiguration, appSchedule: { scheduleTimeline: 'None' }, }, }); expect(installRes.ok()).toBeTruthy();

_{Was this helpful? React with 👍 / 👎 | Reply gitar fix to apply this suggestion}

gitar-bot · 2026-03-30T07:57:48Z

Code Review 👍 Approved with suggestions 0 resolved / 1 findings

Stabilizes flaky search index application tests with targeted fixes. Consider adding response-status validation to the self-healing API POST to ensure proper error handling.

💡 Edge Case: Self-healing API POST lacks response-status check

📄 openmetadata-ui/src/main/resources/ui/playwright/e2e/Pages/SearchIndexApplication.spec.ts:171-178

The self-healing guard (lines 171-178) creates the app via apiContext.post('/api/v1/apps', …) but never inspects the response. If the POST fails (e.g., 400 due to a schema change or 500), the test will proceed as if the app is installed, leading to a confusing downstream failure that obscures the real cause.

Adding a status assertion gives a clear, early failure message.

Suggested fix

const installRes = await apiContext.post('/api/v1/apps', {
  data: {
    name: 'SearchIndexingApplication',
    displayName: 'Search Indexing',
    appConfiguration,
    appSchedule: { scheduleTimeline: 'None' },
  },
});
expect(installRes.ok()).toBeTruthy();

🤖 Prompt for agents

Code Review: Stabilizes flaky search index application tests with targeted fixes. Consider adding response-status validation to the self-healing API POST to ensure proper error handling.

1. 💡 Edge Case: Self-healing API POST lacks response-status check
   Files: openmetadata-ui/src/main/resources/ui/playwright/e2e/Pages/SearchIndexApplication.spec.ts:171-178

   The self-healing guard (lines 171-178) creates the app via `apiContext.post('/api/v1/apps', …)` but never inspects the response. If the POST fails (e.g., 400 due to a schema change or 500), the test will proceed as if the app is installed, leading to a confusing downstream failure that obscures the real cause.
   
   Adding a status assertion gives a clear, early failure message.

   Suggested fix:
   const installRes = await apiContext.post('/api/v1/apps', {
     data: {
       name: 'SearchIndexingApplication',
       displayName: 'Search Indexing',
       appConfiguration,
       appSchedule: { scheduleTimeline: 'None' },
     },
   });
   expect(installRes.ok()).toBeTruthy();

Options

Display: compact → Showing less information.

Comment with these commands to change:

`Compact`
`gitar display:verbose`

_{Was this helpful? React with 👍 / 👎 | Gitar}

sonarqubecloud · 2026-03-30T08:34:24Z

Quality Gate passed for 'open-metadata-ui'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

github-actions · 2026-03-30T10:05:12Z

Failed to cherry-pick changes to the 1.12.4 branch.
Please cherry-pick the changes manually.
You can find more details here.

* fix flaky search index application * fix lint issues * address review comments --------- Co-authored-by: Shrabanti Paul <shrabantipaul@Shrabantis-MacBook-Pro.local>

fix flaky search index application

2720850

shrabantipaul-collate requested a review from a team as a code owner March 26, 2026 10:33

shrabantipaul-collate added the safe to test Add this label to run secure Github workflows on PRs label Mar 26, 2026

shrabantipaul-collate had a problem deploying to test March 26, 2026 10:48 — with GitHub Actions Error

fix lint issues

4e916d8

shrabantipaul-collate temporarily deployed to test March 26, 2026 11:01 — with GitHub Actions Inactive

ShaileshParmar11 reviewed Mar 27, 2026

View reviewed changes

openmetadata-ui/src/main/resources/ui/playwright/e2e/Pages/SearchIndexApplication.spec.ts Outdated Show resolved Hide resolved

Merge branch 'main' into fix-searchIndexApplication-specs

c94f7b3

aniketkatkar97 reviewed Mar 27, 2026

View reviewed changes

openmetadata-ui/src/main/resources/ui/playwright/e2e/Pages/SearchIndexApplication.spec.ts Outdated Show resolved Hide resolved

shrabantipaul-collate temporarily deployed to test March 27, 2026 05:21 — with GitHub Actions Inactive

Shrabanti Paul added 2 commits March 27, 2026 15:49

address review comments

370ccb9

Merge branch 'fix-searchIndexApplication-specs' of https://github.com…

b94fb27

…/open-metadata/OpenMetadata into fix-searchIndexApplication-specs

shrabantipaul-collate had a problem deploying to test March 27, 2026 11:42 — with GitHub Actions Error

siddhant1 approved these changes Mar 27, 2026

View reviewed changes

shrabantipaul-collate added the To release Will cherry-pick this PR into the release branch label Mar 27, 2026

shrabantipaul-collate temporarily deployed to test March 27, 2026 12:29 — with GitHub Actions Inactive

Merge branch 'main' into fix-searchIndexApplication-specs

4bb913f

gitar-bot bot reviewed Mar 30, 2026

View reviewed changes

shrabantipaul-collate temporarily deployed to test March 30, 2026 05:10 — with GitHub Actions Inactive

Merge branch 'main' into fix-searchIndexApplication-specs

02ba984

shrabantipaul-collate temporarily deployed to test March 30, 2026 08:07 — with GitHub Actions Inactive

shrabantipaul-collate merged commit 3f86d4a into main Mar 30, 2026
44 checks passed

shrabantipaul-collate deleted the fix-searchIndexApplication-specs branch March 30, 2026 10:03

ulixius9 pushed a commit that referenced this pull request Mar 30, 2026

fix flaky search index application (#26795)

f6392b9

* fix flaky search index application * fix lint issues * address review comments --------- Co-authored-by: Shrabanti Paul <shrabantipaul@Shrabantis-MacBook-Pro.local>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix flaky search index application#26795

fix flaky search index application#26795
shrabantipaul-collate merged 8 commits intomainfrom
fix-searchIndexApplication-specs

shrabantipaul-collate commented Mar 26, 2026 •

edited by gitar-bot bot

Loading

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

github-actions bot commented Mar 26, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Mar 26, 2026 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

gitar-bot bot Mar 30, 2026

Uh oh!

gitar-bot bot commented Mar 30, 2026 •

edited

Loading

Uh oh!

sonarqubecloud bot commented Mar 30, 2026

Uh oh!

Uh oh!

github-actions bot commented Mar 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

shrabantipaul-collate commented Mar 26, 2026 • edited by gitar-bot bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Describe your changes:

Type of change:

Checklist:

Summary by Gitar

Uh oh!

github-actions bot commented Mar 26, 2026

Uh oh!

github-actions bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Jest test Coverage

UI tests summary

Uh oh!

github-actions bot commented Mar 26, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🟡 Playwright Results — all passed (20 flaky)

Uh oh!

Uh oh!

Uh oh!

gitar-bot bot Mar 30, 2026

Choose a reason for hiding this comment

Uh oh!

gitar-bot bot commented Mar 30, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sonarqubecloud bot commented Mar 30, 2026

Quality Gate passed for 'open-metadata-ui'

Uh oh!

Uh oh!

github-actions bot commented Mar 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

shrabantipaul-collate commented Mar 26, 2026 •

edited by gitar-bot bot

Loading

github-actions bot commented Mar 26, 2026 •

edited

Loading

github-actions bot commented Mar 26, 2026 •

edited

Loading

gitar-bot bot commented Mar 30, 2026 •

edited

Loading